Add --standardize and --no-execute CLI flags #44
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The docs site renderer (Zensical/pymdownx) doesn't understand the "python markdown-code-runner" syntax for code fence language identifiers. This causes the fenced code blocks to be parsed as inline code instead of proper code blocks, breaking the rendering. Add a regex transformation in _transform_readme_links() to strip the "markdown-code-runner" modifier when pulling content from README into the docs templates.
This adds two new CLI flags to support standardizing code fences for compatibility with markdown processors like mkdocs and pandoc: - `--standardize` / `-s`: Post-process to standardize ALL code fences, removing 'markdown-code-runner' modifiers from language identifiers - `--no-execute` / `-n`: Skip code execution entirely These flags can be combined for different use cases: - `--standardize`: Execute code AND standardize output - `--no-execute --standardize`: Only standardize, no execution - Default: Execute code with inline standardization of executed blocks The docs_gen.py script now uses `--standardize` instead of the regex workaround, making the solution available as a CLI option for all users. Closes #26
Document the new CLI flags and Python API parameters: - CLI: --standardize/-s and --no-execute/-n options - Python API: execute and standardize parameters for update_markdown_file - Python API: standardize_code_fences utility function - Added usage examples for all new functionality
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
--standardize/-sflag to post-process and standardize ALL code fences, removingmarkdown-code-runnermodifiers--no-execute/-nflag to skip code execution entirely--standardizeflag instead of a regex workaroundThis provides a library-level CLI solution for compatibility with markdown processors like mkdocs and pandoc that don't understand the
python markdown-code-runnersyntax.Usage
Test plan
standardize_code_fences()functionexecuteparameter inprocess_markdown()andupdate_markdown_file()standardizeparameter inupdate_markdown_file()Closes #26